PXC Documentation

PXC Home

Draw Text

pre 1.18

Draw text on an image.

Node Data

Display name

Draw Text

Internal name

Node_Text

Inheritances

Node_Processor
Node_Text

Inputs

Text

text

Text

enum

Change Case

Output

enum

Dimension

vec2

Fixed Dimension

vec2

Offset

ipadding

Padding

bool

Atlas

Font

font

Font

int

Size

bool

Scale To Fit

Font Settings

font

Fallback Font

vec2

Character Range

bool

Anti-Aliasing

bool

Use Sdf

Letter Settings

float

Letter Spacing

float

Line Height

bool

Monospaced

Alignment

int

Max Line Width

bool

Split Word

enum

H Align

enum

V Align

Path

path

Path

float

Path Shift

bool

Rotate Along Path

Rendering

bool

Round Position

enum

Blend Mode

color

Color

palette

Color By Letter

surface

Texture

Background

bool

Render Background

color

Bg Color

surface

Background

Wave

bool

Wave

slider

Wave Shape

float

Wave Amplitude

float

Wave Scale

rotation

Wave Phase

Trim

bool

Trim

enum

Trim Type

range

Range

bool

Use Full Text Size

Outputs

surface

Surface Out

atlas

Draw Data

Attributes

Color Depth
Interpolation

Draw text to surface.



Properties


Text
TextText to draw.
Change Case(For latin alphabet) Change text case.
Output
DimensionDimension type:\n - Fixed: Fixed size from vec2 value.\n - Dynamic: Set size automaticaly to fit the text content.
OffsetShift draw position.
PaddingAdd extra space in 4 directions.
AtlasOutput each character as array of surface atlases.
Font
FontText font.
SizeFont size.
Scale To FitScale text size to fit output dimension (in fixed mode).
Font Settings
Fallback FontSeconds font to use if a glyph is not existed in the main Font
Use SdfUse sdf to draw text.
Letter Settings
Letter SpacingAdd extra horizontal space between letters.
Line HeightAdd extra vertical space between lines.
MonospacedForce each letter to has different width.
Alignment
Max Line WidthMaximum line width before entering new line (in dynamic mode).
Split WordWhen breaking into new line, whether to use space to divide word or split letter directly.
H AlignHorizontal alignment.
V AlignVertical alignment.
Path (Fixed mode recommended)
PathDraw text along path.
Path ShiftShift text along path.
Rotate Along PathRotate text to path direction.
Rendering
Round PositionRound letter position to integer to prevent anti-aliasing.
ColorBase text color.
Color By LetterMultiply color by letter.
TextureApply texture to each letter.
Background
Bg ColorBackground color.
BackgroundAdd background surface, stretch to output dimension.
Wave
WaveMove text in wave pattern.
Wave ShapeWave shape (0:Sin, 1:Triangle, 2:Square, 3:Sawtooth)
Wave AmplitudeWave size.
Wave ScaleWave width (how many letter can be affected by wave).
Wave PhaseWave position.
Trim (Typewriter effect)
TrimEnable trim effect.
Trim TypeTrim type.
RangeTrim range.
Use Full Text SizeForce dynamic dimension to always fit the full text not trimed.



Commit History


1.21.7.101
  • Add toggle to not split words.
1.21.rc7
  • Fix alpha blending.
1.21.6.011
  • Add Background input.
1.21.5.002
  • Fix error when loading font with empty char glyph.
1.21.4.004
  • Font value now default to the first font in the font folder.
1.21.3.009
  • Add texture interpolation setting.
  • Add glyph texture property.

Related Links